BaseProtocolServer

BaseProtocolServer

protected BaseProtocolServer(TSettings settings)

baseProtocolServer = BaseProtocolServer(settings)

Initializes a new instance.

settings

Server settings.

LoginRateLimiter

protected LoginRateLimiter LoginRateLimiter { get; private set; }

value = baseProtocolServer.LoginRateLimiter
baseProtocolServer.LoginRateLimiter = value

Rate limiter for login attempts (shared across all listeners).

Sessions

public IEnumerable<IMessageListenerSession> Sessions { get; }

value = baseProtocolServer.Sessions

Snapshot of all client sessions currently held by the server. Useful for tests that need to verify server-side session bookkeeping independently of what the client adapter happens to see (a FIX adapter, for example, silently auto-reconnects after a server-side kick, so the client-side DisconnectMessage is not a reliable signal).

Settings

public TSettings Settings { get; }

value = baseProtocolServer.Settings

Settings.

State

public ChannelStates State { get; protected set; }

value = baseProtocolServer.State
baseProtocolServer.State = value

Current server state.

AddSubscription

public void AddSubscription(ServerSubscription subscription)

baseProtocolServer.AddSubscription(subscription)

Add subscription.

subscription

Subscription.

ClearState

protected virtual void ClearState()

baseProtocolServer.ClearState()

Clear all state: listeners, sessions, subscriptions.

Convert

protected string Convert(string value)

result = baseProtocolServer.Convert(value)

Convert text to latin if configured.

CreateSubscription

protected abstract TSubscription CreateSubscription(TClientSession session, string requestId, ServerSubscription subscription, MessageTypes type)

result = baseProtocolServer.CreateSubscription(session, requestId, subscription, type)

Create a subscription info instance.

Disconnect

public void Disconnect(IMessageListenerSession session)

baseProtocolServer.Disconnect(session)

Disconnect session.

session

Session.

DisposeManaged

protected override void DisposeManaged()

baseProtocolServer.DisposeManaged()

Disposes the managed resources. Override this method to add custom clean up of managed resources.

EnqueueMessage

protected void EnqueueMessage(TClientSession session, string requestId, Func<TSubscription, TClientSession, string, CancellationToken, ValueTask> handler, CancellationToken cancellationToken)

baseProtocolServer.EnqueueMessage(session, requestId, handler, cancellationToken)

Enqueue message for a session with request ID.

EnqueueMessage

protected void EnqueueMessage(TSubscription subscription, TClientSession session, string requestId, Func<TSubscription, TClientSession, string, CancellationToken, ValueTask<bool>> handler, CancellationToken cancellationToken)

baseProtocolServer.EnqueueMessage(subscription, session, requestId, handler, cancellationToken)

Core enqueue: schedule work on a client session.

EnqueueMessage

protected void EnqueueMessage(TSubscription[] subscribers, Func<TSubscription, TClientSession, string, CancellationToken, ValueTask> handler, CancellationToken cancellationToken)

baseProtocolServer.EnqueueMessage(subscribers, handler, cancellationToken)

Enqueue message for multiple subscribers.

EnqueueMessage

protected void EnqueueMessage(TSubscription[] subscribers, Func<TSubscription, TClientSession, string, CancellationToken, ValueTask<bool>> handler, CancellationToken cancellationToken)

baseProtocolServer.EnqueueMessage(subscribers, handler, cancellationToken)

Enqueue message for multiple subscribers (with bool result).

EnqueueMessage

protected void EnqueueMessage(TSubscription subscription, Func<TSubscription, TClientSession, string, CancellationToken, ValueTask> handler, CancellationToken cancellationToken)

baseProtocolServer.EnqueueMessage(subscription, handler, cancellationToken)

Enqueue message for a single subscription.

EnqueueMessage

protected void EnqueueMessage(TSubscription subscription, Func<TSubscription, TClientSession, string, CancellationToken, ValueTask<bool>> handler, CancellationToken cancellationToken)

baseProtocolServer.EnqueueMessage(subscription, handler, cancellationToken)

Enqueue message for a single subscription (with bool result).

EnqueueMessage

protected void EnqueueMessage(TClientSession session, Func<TSubscription, TClientSession, string, CancellationToken, ValueTask> handler, CancellationToken cancellationToken)

baseProtocolServer.EnqueueMessage(session, handler, cancellationToken)

Enqueue message for a session (no request ID).

GetSessionKey

protected abstract string GetSessionKey(TClientSession session)

result = baseProtocolServer.GetSessionKey(session)

Get the key used to group client sessions (e.g. SenderCompId).

GetSubscriptions

public IEnumerable<ServerSubscription> GetSubscriptions(IMessageListenerSession session)

result = baseProtocolServer.GetSubscriptions(session)

Get subscription for the specified session.

session

Session.

Returns: Subscriptions.

HasSubscriptions

public bool HasSubscriptions(DataType dataType, SecurityId securityId)

result = baseProtocolServer.HasSubscriptions(dataType, securityId)

Are there subscribers.

IsStubSubscription

protected abstract bool IsStubSubscription(TSubscription subscription)

result = baseProtocolServer.IsStubSubscription(subscription)

Check if subscription is a stub (placeholder).

Load

public override void Load(SettingsStorage storage)

baseProtocolServer.Load(storage)

Loads the state of the object from the specified SettingsStorage.

storage

The SettingsStorage instance from which to load the data.

OnClearListenerState

protected abstract void OnClearListenerState()

baseProtocolServer.OnClearListenerState()

Clear protocol-specific listener state (stop listeners, etc.).

OnStartListeners

protected abstract void OnStartListeners(CancellationToken cancellationToken)

baseProtocolServer.OnStartListeners(cancellationToken)

Start protocol-specific listeners (TCP, etc.). Add tasks to _backgroundTasks.

ProcessInMessage

protected abstract void ProcessInMessage(Message message, CancellationToken cancellationToken)

baseProtocolServer.ProcessInMessage(message, cancellationToken)

Process an incoming message and route to subscribed clients.

ProcessLogout

protected virtual void ProcessLogout(TClientSession session)

baseProtocolServer.ProcessLogout(session)

Process client logout/disconnect.

RaiseNewOutMessage

protected void RaiseNewOutMessage(IMessageListenerSession session, Message message)

baseProtocolServer.RaiseNewOutMessage(session, message)

Write outgoing message to channel.

RaiseSessionConnected

protected void RaiseSessionConnected(IMessageListenerSession session)

baseProtocolServer.RaiseSessionConnected(session)

Raise session connected event.

RaiseSessionDisconnected

protected void RaiseSessionDisconnected(IMessageListenerSession session)

baseProtocolServer.RaiseSessionDisconnected(session)

Raise session disconnected event.

RemoveSubscription

public bool RemoveSubscription(ServerSubscription subscription)

result = baseProtocolServer.RemoveSubscription(subscription)

Remove subscription.

subscription

Subscription.

Returns: if subscription was found, otherwise .

Resume

public bool Resume(ServerSubscription subscription)

result = baseProtocolServer.Resume(subscription)

Resume subscription.

subscription

Subscription.

Returns: if subscription was found, otherwise .

Resume

public void Resume(IMessageListenerSession session)

baseProtocolServer.Resume(session)

Resume session.

session

Session.

RunAsync

public IAsyncEnumerable<ValueTuple<IMessageListenerSession, Message>> RunAsync(CancellationToken cancellationToken)

result = baseProtocolServer.RunAsync(cancellationToken)

Run async message processing and return outgoing messages as IAsyncEnumerable. Opens server at start and closes at end.

Save

public override void Save(SettingsStorage storage)

baseProtocolServer.Save(storage)

Saves the entity's state to the specified settings storage.

ScheduleSessionWork

protected abstract void ScheduleSessionWork(TClientSession session, ServerSubscription subscription, string requestId, Func<TClientSession, string, CancellationToken, ValueTask<bool>> handler)

baseProtocolServer.ScheduleSessionWork(session, subscription, requestId, handler)

Schedule work on a client session's outgoing queue.

SendInMessage

public virtual bool SendInMessage(Message message)

result = baseProtocolServer.SendInMessage(message)

Send incoming message to server for processing and routing to clients.

StartServer

protected void StartServer(CancellationToken cancellationToken)

baseProtocolServer.StartServer(cancellationToken)

Start the server: initialize state, start listeners and background tasks.

StopServer

protected void StopServer()

baseProtocolServer.StopServer()

Stop the server: cancel tasks, complete channels, clear state.

Suspend

public void Suspend(IMessageListenerSession session)

baseProtocolServer.Suspend(session)

Suspend session.

session

Session.

Suspend

public bool Suspend(ServerSubscription subscription)

result = baseProtocolServer.Suspend(subscription)

Suspend subscription.

subscription

Subscription.

Returns: if subscription was found, otherwise .

SessionConnected

public event Action<IMessageListenerSession> SessionConnected

baseProtocolServer.SessionConnected += handler

Session connected event.

SessionDisconnected

public event Action<IMessageListenerSession> SessionDisconnected

baseProtocolServer.SessionDisconnected += handler

Session disconnected event.

StateChanged

public event Action StateChanged

baseProtocolServer.StateChanged += handler

Occurs when the connection state has changed.

SubscriptionChanged

public event Action<ServerSubscription> SubscriptionChanged

baseProtocolServer.SubscriptionChanged += handler

Client subscription changed event.

_backgroundTasks

protected readonly List<Task> _backgroundTasks

value = baseProtocolServer._backgroundTasks

Background tasks (accept clients, process messages, etc.).

_cancellationRequests

protected readonly SynchronizedSet<long> _cancellationRequests

value = baseProtocolServer._cancellationRequests

Pending order cancellation request transaction IDs.

_changedSubscriptions

protected readonly SynchronizedSet<ServerSubscription> _changedSubscriptions

value = baseProtocolServer._changedSubscriptions

Changed subscriptions pending notification.

_clientSessions

protected readonly CachedSynchronizedDictionary<string, CachedSynchronizedList<TClientSession>> _clientSessions

value = baseProtocolServer._clientSessions

Client sessions grouped by session key (e.g. SenderCompId).

_incomingMessages

protected readonly Channel<Message> _incomingMessages

value = baseProtocolServer._incomingMessages

Incoming messages channel.

_outgoingMessages

protected readonly Channel<ValueTuple<IMessageListenerSession, Message>> _outgoingMessages

value = baseProtocolServer._outgoingMessages

Outgoing messages channel (session + message pairs).

_subscriptions

protected readonly SubscriptionHolder<TSubscription, TClientSession> _subscriptions

value = baseProtocolServer._subscriptions

Subscription holder.